<!DOCTYPE html>
<html lang='zh-CN'>
<meta content="authenticity_token" name="csrf-param" />
<meta content="XEEF/057aOB3ELxAfbaQTb/qKDm6yYgz0B09qGZRzbY=" name="csrf-token" />
<meta charset="utf-8"/>
<script>
//<![CDATA[
window.gon = {};gon.locale="zh-CN";gon.sentry_dsn=null;gon.baidu_register_hm_push=null;gon.sensor={"server_url":"https://haveaniceday.gitee.com:3443/sa?project=production","page_type":"其他"};gon.info={"controller_path":"swagger","action_name":"index","current_user":{"id":5048335,"name":"mmbro","username":"mmbro","official":false,"avatar_url":"no_portrait.png#mmbro-mmbro"}};gon.tour_env={"current_user":"mmbro","action_name":"index","original_url":"http://gitee.com/api/v5/swagger","controller_path":"swagger"};gon.doc_version="5.4.27";
//]]>
</script>
<!--<link href="https://assets.gitee.com/assets/grape_swagger_rails/application-7ca1d8e5bfacecd234743f5a245cb259.css" media="all" rel="stylesheet" />-->
<link href="webjars/gitee-ui/assets.gitee.com/assets/grape_swagger_rails/application-7ca1d8e5bfacecd234743f5a245cb259.css" media="all" rel="stylesheet" />
<!--<script src="https://assets.gitee.com/assets/grape_swagger_rails/application-7c4273fea375946cda076ed142ee5b56.js"></script>-->
<script src="webjars/gitee-ui/assets.gitee.com/assets/grape_swagger_rails/application-7c4273fea375946cda076ed142ee5b56.js"></script>
<!--<link href="https://assets.gitee.com/assets/favicon-9007bd527d8a7851c8330e783151df58.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" />-->
<link href="webjars/gitee-ui/assets.gitee.com/assets/favicon-9007bd527d8a7851c8330e783151df58.ico" rel="shortcut icon" type="image/vnd.microsoft.icon" />
<body class='page-docs' style='zoom: 1;'>
<div class='fixed-notice-infos'>
<div class='all-messages'>
<!--<div class='ui info message' id='git-bulletin'>-->
<!--<a href=https://gitee.com/gitee-community/gitee-8th-participate-in-open-source?utm_source=top target='_blank'>倒计时 3 天 | 完成优秀开源项目新手任务赢 Gitee 周边好礼  >></a>-->
<!--<i class='icon remove' id='remove-bulletin'></i>-->
<!--</div>-->
</div>
<div class='ui container'>
<div class='flash-messages' id='messages-container'></div>
</div>
<script>
  (function() {
    $(function() {
      var $error_box, alertTip, notify_content, notify_options, template;
      template = '<div data-notify="container" class="ui {0} message" role="alert">' + '<i data-notify="dismiss" class="close icon"></i>' + '<span data-notify="message">{2}</span>' + '</div>';
      notify_content = null;
      notify_options = {};
      alertTip = '';
      $error_box = $(".flash_error.flash_error_box");
      if (notify_options.type === 'error' && $error_box.length > 0 && !$.isEmptyObject(notify_content.message)) {
        if (notify_content.message === 'captcha_fail') {
          alertTip = "验证码不正确";
        } else if (notify_content.message === 'captcha_expired') {
          alertTip = "验证码已过期，请点击刷新";
        } else if (notify_content.message === 'not_found_in_database') {
          alertTip = "帐号或者密码错误";
        } else if (notify_content.message === 'not_found_and_show_captcha') {
          alertTip = "帐号或者密码错误";
        } else if (notify_content.message === 'phone_captcha_fail') {
          alertTip = "手机验证码不通过";
        } else {
          alertTip = notify_content.message;
        }
        return $error_box.html(alertTip).show();
      } else if (notify_content) {
        if ("index" === 'third_party_binding') {
          return $('#third_party_binding-message').html(notify_content.message).addClass('ui message red');
        }
        notify_options.delay = 3000;
        notify_options.template = template;
        notify_options.offset = {
          x: 10,
          y: 30
        };
        notify_options.element = '#messages-container';
        return $.notify(notify_content, notify_options);
      }
    });
  
  }).call(this);
</script>

</div>
<script>
  (function() {
    $(function() {
      var setCookie;
      setCookie = function(name, value) {
        $.cookie(name, value, {
          path: '/',
          expires: 365
        });
      };
      $('#remove-bulletin, #remove-bulletin-dashboard').on('click', function() {
        setCookie('remove_bulletin', "gitee-maintain-1624873629");
        $('#git-bulletin').hide();
      });
      $('#remove-member-bulletin').on('click', function() {
        setCookie('remove_member_bulletin', "gitee_member_bulletin");
        $(this).parent().hide();
      });
      return $('#remove-gift-bulletin').on('click', function() {
        setCookie('remove_gift_bulletin', "gitee-gift-bulletin");
        $(this).parent().hide();
      });
    });
  
  }).call(this);
</script>
<script>
  function closeMessageBanner(pthis, type, val) {
    var json = {}
  
    val = typeof val === 'undefined' ? null : val
    $(pthis).parent().remove()
    if (type === 'out_of_enterprise_member') {
      json = {type: type, data: val}
    } else if (type === 'enterprise_overdue') {
      json = {type: type, data: val}
    }
    $.post('/profile/close_flash_tip', json)
  }
</script>

<header id='git-header-nav'>
<div class='ui container'>
<div class='ui menu'>
<div class='item gitosc-logo'>
<a href="/"><img alt="logo" class="ui inline image" src="webjars/gitee-ui/gitee.com/static/images/logo.svg?t=158106664" />
</a></div>
<div class='item developer'>
Developer
</div>
<div class='right menu userbar'>
<div class='item ui dropdown empty' data-count-path='webjars/gitee-ui/gitee.com/notifications/unread_count.json' data-enable data-mark-notice-path='webjars/gitee-ui/gitee.com/notifications/mark.json' data-mark-notice-path_='webjars/gitee-ui/gitee.com/notifications/mark' id='notice-dropdown'>
<a class="remind-button" href="/notifications"><i class='iconfont icon-remind'></i>
<div class='notice-count total'></div>
</a><div class='notice-dropdown-panel menu'>
<div class='notice-dropdown-panel-header'>
<div class='tab active' data-data-path='webjars/gitee-ui/gitee.com/notifications/notices_referer.json?scope=referer' data-html-path='webjars/gitee-ui/gitee.com/notifications/referer' data-scope='referer'>
<div class='content'>
@ 我
<div class='notice-count referer'></div>
</div>
</div>
<div class='tab' data-data-path='webjars/gitee-ui/gitee.com/notifications/notices_infos.json?scope=infos' data-html-path='webjars/gitee-ui/gitee.com/notifications/infos' data-scope='infos'>
<div class='content'>
通知
<div class='notice-count infos'></div>
</div>
</div>
<div class='tab' data-data-path='webjars/gitee-ui/gitee.com/notifications/notices_messages.json?scope=messages' data-html-path='webjars/gitee-ui/gitee.com/notifications/messages' data-scope='messages'>
<div class='content'>
私信
<div class='notice-count messages'></div>
</div>
</div>
</div>
<div class='item notice-dropdown-panel-container'>
<div class='ui dimmer over active'>
<div class='ui loader'></div>
</div>
<div class='notice-list'></div>
<div class='notice-dropdown-panel-blank'>
暂没有新消息
</div>
</div>
<div class='notice-dropdown-panel-footer'>
<div class='action'>
<div class='side left'>
<a class="mark-notices" href="javascript: void(0);">当前标记为已读
</a></div>
<div class='side right'>
<a class="load-all" href="javascript: void(0);" target="_blank">查看全部
</a></div>
</div>
</div>
</div>
</div>

<div class='ui dropdown link item' id='git-nav-create'>
<i class='iconfont icon-add-thin'></i>
<div class='right menu'>
<a class="item" href="/projects/new"><i class='add square icon'></i>
新建仓库
</a><a class="item" href="/mmbro/codes/new"><i class='code icon'></i>
发布代码片段
</a><a class="item" href="/organizations/new"><i class='group icon'></i>
创建组织
</a><a class="item" href="/enterprises/new"><i class='icon iconfont icon-enterprise'></i>
开通企业版
</a><a class="item" href="/projects/import/url"><i class='github icon'></i>
从 GitHub / GitLab 导入仓库
</a></div>
</div>
<div class='ui dropdown item' id='git-nav-user'>
<img avatar="mmbro-mmbro" class="ui avatar image" />
<i class='dropdown icon'></i>
<div class='right menu'>
<a class="item" href="/mmbro"><i class='iconfont icon-ic-home'></i>
个人主页
</a><a class="item" href="/mmbro/starred"><i class='iconfont icon-star'></i>
我的星选集
</a><a class="item" href="/profile/account_information"><div class='mayun-icon my-ic-edit my-ic-edit-dims'></div>
设置
</a><div class='divider'></div>
<a class="item" href="https://gitee.com/help" target="_blank"><div class='mayun-icon my-ic-help my-ic-help-dims'></div>
帮助
</a><div class='divider'></div>
<a class="item destroy-user-session" data-method="delete" href="/logout" rel="nofollow"><div class='mayun-icon my-ic-exit my-ic-exit-dims'></div>
退出
</a></div>
</div>
<script>
  $('.destroy-user-session').on('click', function() {
    $.cookie('access_token', null, { path: '/' });
  })
</script>

</div>
</div>
</div>
</header>
<div class='ui secondary pointing menu' id='api-doc-menu'>
<a class='active item' href='/api/v5/swagger'>API 文档</a>
<a class='item' href='/api/v5/oauth_doc'>OAuth文档</a>
<a class='ui button apply-oauth' href='/oauth/authorize?client_id=8ac7a94ff19ddb4b9d267d525c048e2845f589cf3b1e8d09ef2568ca63f74603&amp;redirect_uri=https%3A%2F%2Fgitee.com%2Fapi%2Fv5%2Fswagger&amp;response_type=code'>申请授权</a>
</div>
<script>
  $('#git-header-nav .ui.dropdown').dropdown({on: 'hover'});
  
  function deleteCookie(name) {
    document.cookie = name +'=; Path=/; Expires=Thu, 01 Jan 1970 00:00:01 GMT;';
  };
  $('a#logout').click(function () {
    if (false) {
      deleteCookie('enterprise_access_token');
    } else {
      deleteCookie('access_token');
    }
    location.reload();
  });
  
  $('.destroy-user-session').on('click', function() {
    deleteCookie('access_token');
    deleteCookie('enterprise_access_token');
  });
</script>

<script>
  var userAgent = navigator.userAgent;
  var isLessIE11 = userAgent.indexOf('compatible') > -1 && userAgent.indexOf('MSIE') > -1;
  if(isLessIE11){
    var can_access = ""
    if (can_access != "true"){
      window.location.href = "/incompatible.html";
    }
  }
</script>

<head>
<title>Gitee API 文档</title>
<!--<link href="https://assets.gitee.com/webpacks/css/api_doc-048d4b392c555370f917.css" media="all" rel="stylesheet" />-->
<link href="webjars/gitee-ui/assets.gitee.com/webpacks/css/api_doc-048d4b392c555370f917.css" media="all" rel="stylesheet" />
</head>
<div id='app'></div>
<script src="webjars/gitee-ui/global-config.js"></script>
<script src="webjars/gitee-ui/assets.gitee.com/webpacks/vendors_lib-7ff466a6da368d391eda.js"></script>
<script src="webjars/gitee-ui/assets.gitee.com/webpacks/api_doc-c6bf10a2ca3d2356cf06.bundle.js"></script>

</body>
<div class='side-toolbar'>
<div class='button gotop popup' data-content='回到顶部' data-position='left center' id='gotop'>
<i class='iconfont icon-top'></i>
</div>
</div>
</html>
<script>
  (function() {
    var $gotop, $root, host, update;
  
    $root = $('body, html');
  
    $gotop = $('#gotop').on('click', function() {
      return $root.animate({
        scrollTop: 0
      }, 500);
    });
  
    update = function() {
      if ($(window).scrollTop() > 50) {
        return $gotop.addClass('active');
      } else {
        return $gotop.removeClass('active');
      }
    };
  
    $(window).on('scroll', update);
  
    update();
  
    host = window.location.hostname;
  
    if (host === 'git.oschina.net') {
      window.location.href = window.location.href.replace(host, 'gitee.com');
    }
  
  }).call(this);
</script>
